<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>{include_php}</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Smarty マニュアル">
<link rel="up" href="language.builtin.functions.html" title="Chapter 7. 組み込み関数">
<link rel="prev" href="language.function.include.html" title="{include}">
<link rel="next" href="language.function.insert.html" title="{insert}">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">{include_php}</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="language.function.include.html">Prev</a> </td>
<th width="60%" align="center">Chapter 7. 組み込み関数</th>
<td width="20%" align="right"> <a accesskey="n" href="language.function.insert.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="sect1" title="{include_php}">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="language.function.include.php"></a>{include_php}</h2></div></div></div>
<div class="note" title="テクニカルノート" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">テクニカルノート</h3>
<p>
    <code class="varname">{include_php}</code> は Smarty ではほとんど推奨されていません。
    カスタムテンプレート関数を使用すれば、同等の機能を実現できます。
    <code class="varname">{include_php}</code> を使用する理由がもしあるとすれば、
    <a class="link" href="variable.plugins.dir.html" title="$plugins_dir"><code class="filename">plugins/</code></a>
    ディレクトリやアプリケーションのコードから PHP 関数を完全に隔離したい場合などです。
    詳細は <a class="link" href="tips.componentized.templates.html" title="コンポーネント化したテンプレート">コンポーネント化したテンプレートの例
    </a> を参照してください。
   </p>
</div>
<div class="informaltable"><table border="1">
<colgroup>
<col align="center">
<col align="center">
<col align="center">
<col align="center">
<col>
</colgroup>
<thead><tr>
<th align="center">属性名</th>
<th align="center">型</th>
<th align="center">必須</th>
<th align="center">デフォルト</th>
<th>概要</th>
</tr></thead>
<tbody>
<tr>
<td align="center">file</td>
<td align="center">string</td>
<td align="center">Yes</td>
<td align="center"><span class="emphasis"><em>n/a</em></span></td>
<td>インクルードする PHP ファイル名</td>
</tr>
<tr>
<td align="center">once</td>
<td align="center">boolean</td>
<td align="center">No</td>
<td align="center"><span class="emphasis"><em><code class="constant">TRUE</code></em></span></td>
<td>同じ PHP ファイルが複数回インクルードされた場合に、一度だけインクルードするかどうか</td>
</tr>
<tr>
<td align="center">assign</td>
<td align="center">string</td>
<td align="center">No</td>
<td align="center"><span class="emphasis"><em>n/a</em></span></td>
<td>include_php の出力を格納する変数名</td>
</tr>
</tbody>
</table></div>
<p>
  <code class="varname">{include_php}</code> タグを使用して、PHP スクリプトをテンプレートにインクルードします。
  <a class="link" href="variable.security.html" title="$security"><em class="parameter"><code>$security</code></em></a>
  が有効な場合は、PHP スクリプトは <a class="link" href="variable.trusted.dir.html" title="$trusted_dir"><em class="parameter"><code>$trusted_dir</code></em></a>
  で指定されたディレクトリに存在する必要があります。<code class="varname">{include_php}</code>
  タグには <em class="parameter"><code>file</code></em> 属性が必須で、
  ここにはインクルードする PHP ファイルへのパスを指定します。
  このパスは <a class="link" href="variable.trusted.dir.html" title="$trusted_dir"><em class="parameter"><code>$trusted_dir</code></em></a>
  からの相対パスか絶対パスのいずれかとなります。
 </p>
<p>
  デフォルトでは、PHPファイルはテンプレート内で複数回呼ばれても一度しかインクルードしません。
  <em class="parameter"><code>once</code></em> 属性によって毎回インクルードするべきかどうかを指定できます。
  この属性を <code class="constant">FALSE</code> に設定すると、テンプレート内でインクルードの指示がある毎に
  PHP スクリプトをインクルードします。
 </p>
<p>
  オプションで <em class="parameter"><code>assign</code></em> 属性を渡すこともできます。
  これは、<code class="varname">{include_php}</code> の出力をブラウザに表示させる代わりに
  変数に格納したい場合に、その変数名を指定します。
 </p>
<p>
  Smarty オブジェクトは、インクルードした PHP スクリプト内で
  <em class="parameter"><code>$this</code></em> として使用可能です。
 </p>
<div class="example">
<a name="id2777400"></a><p class="title"><b>Example 7.21. {include_php} 関数</b></p>
<div class="example-contents">
<p><code class="filename">load_nav.php</code> ファイル</p>
<pre class="programlisting">

&lt;?php

// mysql データベースから変数の値を読み込み、それをテンプレートに割り当てます
require_once('database.class.php');
$db = new Db();
$db-&gt;query('select url, name from navigation order by name');
$this-&gt;assign('navigation', $db-&gt;getRows());

?&gt;

  </pre>
<p>
   テンプレート
  </p>
<pre class="programlisting">

{* 絶対パス、あるいは $trusted_dir からの相対パスか *}
{include_php file='/path/to/load_nav.php'}

{foreach item='nav' from=$navigation}
  &lt;a href="{$nav.url}"&gt;{$nav.name}&lt;/a&gt;&lt;br /&gt;
{/foreach}

  </pre>
</div>
</div>
<br class="example-break"><p>
  <a class="link" href="language.function.include.html" title="{include}"><code class="varname">{include}</code></a>、
  <a class="link" href="variable.security.html" title="$security"><em class="parameter"><code>$security</code></em></a>、
<a class="link" href="variable.trusted.dir.html" title="$trusted_dir"><em class="parameter"><code>$trusted_dir</code></em></a>、
  <a class="link" href="language.function.php.html" title="{php}"><code class="varname">{php}</code></a>、<a class="link" href="language.builtin.functions.html#language.function.capture" title="{capture}"><code class="varname">{capture}</code></a>、<a class="link" href="template.resources.html" title="テンプレートリソース">テンプレートリソース</a> および <a class="link" href="tips.componentized.templates.html" title="コンポーネント化したテンプレート">コンポーネント化したテンプレート</a>
  も参照してください。
 </p>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="language.function.include.html">Prev</a> </td>
<td width="20%" align="center"><a accesskey="u" href="language.builtin.functions.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href="language.function.insert.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">{include} </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
<td width="40%" align="right" valign="top"> {insert}</td>
</tr>
</table>
</div>
</body>
</html>
